Key considerations
- This is implemented for Jamaica BU, data and PDF content will be retrieved from Liberate system for Liberate accounts and Cerillion system for Cerillion accounts. Input parameters are account number and bill reference number.
- For sample response refer example in RAML.
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
http://[localhost]:[port]/bot-ux/{version}/{businessId}/accounts/{accountNumber}/bills/pdf?billReference={billReference}
note: here version is V1.
URI Parameter
| Name | Type | Description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | M |
| accountNumber | string | account number | M |
Query Parameter
| Name | Type | Description | required |
|---|
| billReference | string | bill reference number | M |
| Name | Type | Description | required |
|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.</br>Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b </br> | M |
| lob | String | TheLine of Business Identifier currently available are:<br>Enum: PREPAID , POSTPAID, FIXED<br> | M |
| Name | Type | Description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | M |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | M |